docs: Documentation for XSPolicy.can_run command
authorKeir Fraser <keir.fraser@citrix.com>
Tue, 1 Apr 2008 09:05:52 +0000 (10:05 +0100)
committerKeir Fraser <keir.fraser@citrix.com>
Tue, 1 Apr 2008 09:05:52 +0000 (10:05 +0100)
Signed-off-by: Stefan Berger <stefanb@us.ibm.com>
docs/xen-api/revision-history.tex
docs/xen-api/xenapi-coversheet.tex
docs/xen-api/xenapi-datamodel.tex

index d282adb106b2aa9484fcbf51542a3c6ba7a0e25d..cf4a211f625f797c2b83986b81f560eca98797a8 100644 (file)
     \end{flushleft}
    \end{minipage}\\
   \hline
-  1.0.2 & 11th Feb. 08 & S. Berger &
+  1.0.3 & 11th Feb. 08 & S. Berger &
    \begin{minipage}[t]{7cm}
     \begin{flushleft}
      Added table of contents and hyperlink cross reference.
     \end{flushleft}
    \end{minipage}\\
   \hline
+  1.0.4 & 23rd March 08 & S. Berger &
+   \begin{minipage}[t]{7cm}
+    \begin{flushleft}
+     Added XSPolicy.can\_run
+    \end{flushleft}
+   \end{minipage}\\
+  \hline
  \end{tabular}
-\end{center}
\ No newline at end of file
+\end{center}
index c35190acfe67a7973420d166e999f664415d6c8b..ab6f0e3effd72c56dfdd0fbacb3bcf2eefca7b5d 100644 (file)
@@ -22,7 +22,7 @@
 \newcommand{\releasestatement}{Stable Release}
 
 %% Document revision
-\newcommand{\revstring}{API Revision 1.0.2}
+\newcommand{\revstring}{API Revision 1.0.4}
 
 %% Document authors
 \newcommand{\docauthors}{
index 102b59e04c0e086f784cf4741479ab2a0a6f9469..a9ebaad545eeaf4ea20634da5f2d1b529ee0879c 100644 (file)
@@ -14938,6 +14938,41 @@ Currently active instantiation flags.
 \vspace{0.3cm}
 \vspace{0.3cm}
 \vspace{0.3cm}
+\subsubsection{RPC name:~can\_run}
+
+{\bf Overview:}
+Check whether a VM with the given security label could run on the system.
+
+ \noindent {\bf Signature:}
+\begin{verbatim} int can_run (session_id s, string security_label)\end{verbatim}
+
+
+\noindent{\bf Arguments:}
+
+
+\vspace{0.3cm}
+\begin{tabular}{|c|c|p{7cm}|}
+ \hline
+{\bf type} & {\bf name} & {\bf description} \\ \hline
+{\tt string } & security_label & reference to the object \\ \hline
+
+\end{tabular}
+
+\vspace{0.3cm}
+
+ \noindent {\bf Return Type:}
+{\tt
+int
+}
+
+
+Error code indicating whether a VM with the given security label could run.
+If zero, it can run.
+
+\vspace{0.3cm}
+
+\noindent{\bf Possible Error Codes:} {\tt SECURITY\_ERROR}
+
 \subsubsection{RPC name:~get\_all}
 
 {\bf Overview:}